<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span><a name="line.1"></a>
<span class="sourceLineNo">002</span>/*<a name="line.2"></a>
<span class="sourceLineNo">003</span> * Copyright (C) 2014 Archie L. Cobbs. All rights reserved.<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * $Id: EnumFieldType.html 842 2015-03-07 18:20:42Z archie.cobbs $<a name="line.5"></a>
<span class="sourceLineNo">006</span> */<a name="line.6"></a>
<span class="sourceLineNo">007</span><a name="line.7"></a>
<span class="sourceLineNo">008</span>package org.jsimpledb.core;<a name="line.8"></a>
<span class="sourceLineNo">009</span><a name="line.9"></a>
<span class="sourceLineNo">010</span>import com.google.common.base.Function;<a name="line.10"></a>
<span class="sourceLineNo">011</span>import com.google.common.collect.Lists;<a name="line.11"></a>
<span class="sourceLineNo">012</span><a name="line.12"></a>
<span class="sourceLineNo">013</span>import java.util.Collection;<a name="line.13"></a>
<span class="sourceLineNo">014</span>import java.util.LinkedHashMap;<a name="line.14"></a>
<span class="sourceLineNo">015</span>import java.util.List;<a name="line.15"></a>
<span class="sourceLineNo">016</span>import java.util.Map;<a name="line.16"></a>
<span class="sourceLineNo">017</span><a name="line.17"></a>
<span class="sourceLineNo">018</span>import org.dellroad.stuff.java.EnumUtil;<a name="line.18"></a>
<span class="sourceLineNo">019</span><a name="line.19"></a>
<span class="sourceLineNo">020</span>/**<a name="line.20"></a>
<span class="sourceLineNo">021</span> * The {@link FieldType} for {@link EnumField}s.<a name="line.21"></a>
<span class="sourceLineNo">022</span> *<a name="line.22"></a>
<span class="sourceLineNo">023</span> * &lt;p&gt;<a name="line.23"></a>
<span class="sourceLineNo">024</span> * Each {@link EnumFieldType} instance has an ordered list of {@link String} identifiers; two {@link EnumFieldType}<a name="line.24"></a>
<span class="sourceLineNo">025</span> * instances are not compatible unless they have identical identifier lists. The identifiers must be valid Java identifiers.<a name="line.25"></a>
<span class="sourceLineNo">026</span> * &lt;/p&gt;<a name="line.26"></a>
<span class="sourceLineNo">027</span> *<a name="line.27"></a>
<span class="sourceLineNo">028</span> * &lt;p&gt;<a name="line.28"></a>
<span class="sourceLineNo">029</span> * Null values are supported by this class.<a name="line.29"></a>
<span class="sourceLineNo">030</span> * &lt;/p&gt;<a name="line.30"></a>
<span class="sourceLineNo">031</span> */<a name="line.31"></a>
<span class="sourceLineNo">032</span>public class EnumFieldType extends NullSafeType&lt;EnumValue&gt; {<a name="line.32"></a>
<span class="sourceLineNo">033</span><a name="line.33"></a>
<span class="sourceLineNo">034</span>    public static final String IDENT_PATTERN = "\\p{javaJavaIdentifierStart}\\p{javaJavaIdentifierPart}*";<a name="line.34"></a>
<span class="sourceLineNo">035</span><a name="line.35"></a>
<span class="sourceLineNo">036</span>    /**<a name="line.36"></a>
<span class="sourceLineNo">037</span>     * Constructor to use when there is an associated {@link Enum} type;<a name="line.37"></a>
<span class="sourceLineNo">038</span>     * {@link #getEnumType} will return {@code enumType}.<a name="line.38"></a>
<span class="sourceLineNo">039</span>     *<a name="line.39"></a>
<span class="sourceLineNo">040</span>     * @param enumType Java {@link Enum} type from which to derive the ordered identifier list<a name="line.40"></a>
<span class="sourceLineNo">041</span>     * @param &lt;T&gt; enum type<a name="line.41"></a>
<span class="sourceLineNo">042</span>     * @throws NullPointerException if {@code enumType} is null<a name="line.42"></a>
<span class="sourceLineNo">043</span>     */<a name="line.43"></a>
<span class="sourceLineNo">044</span>    public &lt;T extends Enum&lt;T&gt;&gt; EnumFieldType(Class&lt;T&gt; enumType) {<a name="line.44"></a>
<span class="sourceLineNo">045</span>        super(new EnumType(enumType, enumType.getName(), EnumFieldType.getIdentifiers(enumType)));<a name="line.45"></a>
<span class="sourceLineNo">046</span>    }<a name="line.46"></a>
<span class="sourceLineNo">047</span><a name="line.47"></a>
<span class="sourceLineNo">048</span>    /**<a name="line.48"></a>
<span class="sourceLineNo">049</span>     * Constructor to use when there is no corresponding {@link Enum} type;<a name="line.49"></a>
<span class="sourceLineNo">050</span>     * {@link #getEnumType} will return null.<a name="line.50"></a>
<span class="sourceLineNo">051</span>     *<a name="line.51"></a>
<span class="sourceLineNo">052</span>     * @param name name of this type<a name="line.52"></a>
<span class="sourceLineNo">053</span>     * @param idents ordered list of identifiers<a name="line.53"></a>
<span class="sourceLineNo">054</span>     * @throws IllegalArgumentException if {@code name} is null or invalid<a name="line.54"></a>
<span class="sourceLineNo">055</span>     * @throws IllegalArgumentException if {@code idents} is null or contains a duplicate or invalid identifier<a name="line.55"></a>
<span class="sourceLineNo">056</span>     */<a name="line.56"></a>
<span class="sourceLineNo">057</span>    public EnumFieldType(String name, List&lt;String&gt; idents) {<a name="line.57"></a>
<span class="sourceLineNo">058</span>        super(new EnumType(null, name, idents));<a name="line.58"></a>
<span class="sourceLineNo">059</span>    }<a name="line.59"></a>
<span class="sourceLineNo">060</span><a name="line.60"></a>
<span class="sourceLineNo">061</span>    /**<a name="line.61"></a>
<span class="sourceLineNo">062</span>     * Get the identifiers associated with this instance in ordinal order.<a name="line.62"></a>
<span class="sourceLineNo">063</span>     *<a name="line.63"></a>
<span class="sourceLineNo">064</span>     * @return unmodifiable, ordinally ordered list of identifiers<a name="line.64"></a>
<span class="sourceLineNo">065</span>     */<a name="line.65"></a>
<span class="sourceLineNo">066</span>    public List&lt;String&gt; getIdentifiers() {<a name="line.66"></a>
<span class="sourceLineNo">067</span>        return ((EnumType)this.inner).getIdentifiers();<a name="line.67"></a>
<span class="sourceLineNo">068</span>    }<a name="line.68"></a>
<span class="sourceLineNo">069</span><a name="line.69"></a>
<span class="sourceLineNo">070</span>    /**<a name="line.70"></a>
<span class="sourceLineNo">071</span>     * Get the {@link Enum} type associated with this instance, if known.<a name="line.71"></a>
<span class="sourceLineNo">072</span>     *<a name="line.72"></a>
<span class="sourceLineNo">073</span>     * @return associated {@link Enum} type, or null if actual {@link Enum} type is unknown<a name="line.73"></a>
<span class="sourceLineNo">074</span>     */<a name="line.74"></a>
<span class="sourceLineNo">075</span>    public Class&lt;? extends Enum&lt;?&gt;&gt; getEnumType() {<a name="line.75"></a>
<span class="sourceLineNo">076</span>        return ((EnumType)this.inner).getEnumType();<a name="line.76"></a>
<span class="sourceLineNo">077</span>    }<a name="line.77"></a>
<span class="sourceLineNo">078</span><a name="line.78"></a>
<span class="sourceLineNo">079</span>    /**<a name="line.79"></a>
<span class="sourceLineNo">080</span>     * Create an {@link EnumFieldType} instance suitable for use with the given {@link Enum} type.<a name="line.80"></a>
<span class="sourceLineNo">081</span>     *<a name="line.81"></a>
<span class="sourceLineNo">082</span>     * @param enumType Java {@link Enum} type from which to derive the ordered identifier list<a name="line.82"></a>
<span class="sourceLineNo">083</span>     * @return an {@link EnumFieldType} based on {@code enumType}<a name="line.83"></a>
<span class="sourceLineNo">084</span>     * @throws ClassCastException if {@code enumType} does not subclass {@link Enum}<a name="line.84"></a>
<span class="sourceLineNo">085</span>     * @throws NullPointerException if {@code enumType} is null<a name="line.85"></a>
<span class="sourceLineNo">086</span>     */<a name="line.86"></a>
<span class="sourceLineNo">087</span>    public static EnumFieldType create(Class&lt;?&gt; enumType) {<a name="line.87"></a>
<span class="sourceLineNo">088</span>        return EnumFieldType.doCreate(enumType);<a name="line.88"></a>
<span class="sourceLineNo">089</span>    }<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span>    // This method exists solely to bind the generic type parameters<a name="line.91"></a>
<span class="sourceLineNo">092</span>    @SuppressWarnings("unchecked")<a name="line.92"></a>
<span class="sourceLineNo">093</span>    private static &lt;T extends Enum&lt;T&gt;&gt; EnumFieldType doCreate(Class&lt;?&gt; enumType) {<a name="line.93"></a>
<span class="sourceLineNo">094</span>        return new EnumFieldType((Class&lt;T&gt;)enumType.asSubclass(Enum.class));<a name="line.94"></a>
<span class="sourceLineNo">095</span>    }<a name="line.95"></a>
<span class="sourceLineNo">096</span><a name="line.96"></a>
<span class="sourceLineNo">097</span>    /**<a name="line.97"></a>
<span class="sourceLineNo">098</span>     * Create an {@link EnumFieldType} instance suitable for use with the given identifier list.<a name="line.98"></a>
<span class="sourceLineNo">099</span>     *<a name="line.99"></a>
<span class="sourceLineNo">100</span>     * &lt;p&gt;<a name="line.100"></a>
<span class="sourceLineNo">101</span>     * If {@code name} is the name of an {@link Enum} class with matching identifiers, then it will<a name="line.101"></a>
<span class="sourceLineNo">102</span>     * associated with the created instance and returned by its {@link #getEnumType} method.<a name="line.102"></a>
<span class="sourceLineNo">103</span>     * &lt;/p&gt;<a name="line.103"></a>
<span class="sourceLineNo">104</span>     *<a name="line.104"></a>
<span class="sourceLineNo">105</span>     * @param name name of the type<a name="line.105"></a>
<span class="sourceLineNo">106</span>     * @param idents ordered list of identifiers<a name="line.106"></a>
<span class="sourceLineNo">107</span>     * @return an {@link EnumFieldType} based on the specified {@code idents}<a name="line.107"></a>
<span class="sourceLineNo">108</span>     * @throws IllegalArgumentException if {@code name} is null or invalid<a name="line.108"></a>
<span class="sourceLineNo">109</span>     * @throws IllegalArgumentException if {@code idents} is null or contains a duplicate or invalid identifier<a name="line.109"></a>
<span class="sourceLineNo">110</span>     */<a name="line.110"></a>
<span class="sourceLineNo">111</span>    public static EnumFieldType create(String name, List&lt;String&gt; idents) {<a name="line.111"></a>
<span class="sourceLineNo">112</span>        return EnumFieldType.doCreate(name, idents);<a name="line.112"></a>
<span class="sourceLineNo">113</span>    }<a name="line.113"></a>
<span class="sourceLineNo">114</span><a name="line.114"></a>
<span class="sourceLineNo">115</span>    // This method exists solely to bind the generic type parameters<a name="line.115"></a>
<span class="sourceLineNo">116</span>    @SuppressWarnings("unchecked")<a name="line.116"></a>
<span class="sourceLineNo">117</span>    private static &lt;T extends Enum&lt;T&gt;&gt; EnumFieldType doCreate(String name, List&lt;String&gt; idents) {<a name="line.117"></a>
<span class="sourceLineNo">118</span>        do {<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span>            // Search for Enum type<a name="line.120"></a>
<span class="sourceLineNo">121</span>            final Class&lt;T&gt; enumType;<a name="line.121"></a>
<span class="sourceLineNo">122</span>            try {<a name="line.122"></a>
<span class="sourceLineNo">123</span>                enumType = (Class&lt;T&gt;)Class.forName(name, false,<a name="line.123"></a>
<span class="sourceLineNo">124</span>                  Thread.currentThread().getContextClassLoader()).asSubclass(Enum.class);<a name="line.124"></a>
<span class="sourceLineNo">125</span>            } catch (Exception e) {<a name="line.125"></a>
<span class="sourceLineNo">126</span>                break;<a name="line.126"></a>
<span class="sourceLineNo">127</span>            }<a name="line.127"></a>
<span class="sourceLineNo">128</span><a name="line.128"></a>
<span class="sourceLineNo">129</span>            // Validate it has the expected identifier list<a name="line.129"></a>
<span class="sourceLineNo">130</span>            if (!EnumFieldType.getIdentifiers(enumType).equals(idents))<a name="line.130"></a>
<span class="sourceLineNo">131</span>                break;<a name="line.131"></a>
<span class="sourceLineNo">132</span><a name="line.132"></a>
<span class="sourceLineNo">133</span>            // We're good<a name="line.133"></a>
<span class="sourceLineNo">134</span>            return new EnumFieldType(enumType);<a name="line.134"></a>
<span class="sourceLineNo">135</span>        } while (false);<a name="line.135"></a>
<span class="sourceLineNo">136</span><a name="line.136"></a>
<span class="sourceLineNo">137</span>        // Enum type not found or has incompatible identifier list<a name="line.137"></a>
<span class="sourceLineNo">138</span>        return new EnumFieldType(name, idents);<a name="line.138"></a>
<span class="sourceLineNo">139</span>    }<a name="line.139"></a>
<span class="sourceLineNo">140</span><a name="line.140"></a>
<span class="sourceLineNo">141</span>    /**<a name="line.141"></a>
<span class="sourceLineNo">142</span>     * Validate a list of enum identifiers and build a mapping from identifier to corresponding {@link EnumValue}.<a name="line.142"></a>
<span class="sourceLineNo">143</span>     * The returned mapping will iterate the {@link EnumValue}s in ordinal order.<a name="line.143"></a>
<span class="sourceLineNo">144</span>     *<a name="line.144"></a>
<span class="sourceLineNo">145</span>     * @param idents enum identifiers<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * @return ordinally ordered mapping from identifier to {@link EnumValue}<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * @throws IllegalArgumentException if {@code idents} is null<a name="line.147"></a>
<span class="sourceLineNo">148</span>     * @throws IllegalArgumentException if any identifier in {@code idents} is null, duplicate, or not a valid Java identifier<a name="line.148"></a>
<span class="sourceLineNo">149</span>     */<a name="line.149"></a>
<span class="sourceLineNo">150</span>    public static Map&lt;String, EnumValue&gt; validateIdentifiers(List&lt;String&gt; idents) {<a name="line.150"></a>
<span class="sourceLineNo">151</span>        if (idents == null)<a name="line.151"></a>
<span class="sourceLineNo">152</span>            throw new IllegalArgumentException("null idents");<a name="line.152"></a>
<span class="sourceLineNo">153</span>        final LinkedHashMap&lt;String, EnumValue&gt; identifierMap = idents instanceof Collection ?<a name="line.153"></a>
<span class="sourceLineNo">154</span>          new LinkedHashMap&lt;String, EnumValue&gt;(((Collection&lt;?&gt;)idents).size()) : new LinkedHashMap&lt;String, EnumValue&gt;();<a name="line.154"></a>
<span class="sourceLineNo">155</span>        for (String ident : idents) {<a name="line.155"></a>
<span class="sourceLineNo">156</span>            final int index = identifierMap.size();<a name="line.156"></a>
<span class="sourceLineNo">157</span>            if (ident == null)<a name="line.157"></a>
<span class="sourceLineNo">158</span>                throw new IllegalArgumentException("invalid null enum identifier at index " + index);<a name="line.158"></a>
<span class="sourceLineNo">159</span>            if (ident.equals("null") || !ident.matches(IDENT_PATTERN))<a name="line.159"></a>
<span class="sourceLineNo">160</span>                throw new IllegalArgumentException("invalid enum identifier `" + ident + "' at index " + index);<a name="line.160"></a>
<span class="sourceLineNo">161</span>            final EnumValue otherValue = identifierMap.put(ident, new EnumValue(ident, index));<a name="line.161"></a>
<span class="sourceLineNo">162</span>            if (otherValue != null) {<a name="line.162"></a>
<span class="sourceLineNo">163</span>                throw new IllegalArgumentException("invalid duplicate enum identifier `" + ident<a name="line.163"></a>
<span class="sourceLineNo">164</span>                  + "' at indexes " + otherValue.getOrdinal() + " and " + index);<a name="line.164"></a>
<span class="sourceLineNo">165</span>            }<a name="line.165"></a>
<span class="sourceLineNo">166</span>        }<a name="line.166"></a>
<span class="sourceLineNo">167</span>        return identifierMap;<a name="line.167"></a>
<span class="sourceLineNo">168</span>    }<a name="line.168"></a>
<span class="sourceLineNo">169</span><a name="line.169"></a>
<span class="sourceLineNo">170</span>    @SuppressWarnings("unchecked")<a name="line.170"></a>
<span class="sourceLineNo">171</span>    private static &lt;T extends Enum&lt;T&gt;&gt; List&lt;String&gt; getIdentifiers(Class&lt;T&gt; enumType) {<a name="line.171"></a>
<span class="sourceLineNo">172</span>        return Lists.transform(EnumUtil.getValues(enumType), new Function&lt;T, String&gt;() {<a name="line.172"></a>
<span class="sourceLineNo">173</span>            @Override<a name="line.173"></a>
<span class="sourceLineNo">174</span>            public String apply(T value) {<a name="line.174"></a>
<span class="sourceLineNo">175</span>                return value.name();<a name="line.175"></a>
<span class="sourceLineNo">176</span>            }<a name="line.176"></a>
<span class="sourceLineNo">177</span>        });<a name="line.177"></a>
<span class="sourceLineNo">178</span>    }<a name="line.178"></a>
<span class="sourceLineNo">179</span>}<a name="line.179"></a>
<span class="sourceLineNo">180</span><a name="line.180"></a>




























































</pre>
</div>
</body>
</html>
